/*
 * Copyright (c) 2014, marco.tamburelli@gmail.com
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met: 
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.omorphdb.core.io;

import java.io.IOException;

/**
 * Enables the read access to a file, providing methods to read to that file.
 * 
 * @author Marco Tamburelli
 */
public interface Reader
{
	/**
	 * Sets the absolute position of the cursor within the file.
	 * 
	 * Note that at the initial state the cursor should be positioned at the
	 * beginning of the file, at the 0 position.
	 * 
	 * @param position
	 * @throws IOException
	 */
	void setCursor(long position) throws IOException;

	/**
	 * Returns the position of the cursor within the file.
	 * 
	 * Note that at the initial state the cursor should be positioned at the
	 * beginning of the file, at the 0 position.
	 * 
	 * @return
	 * @throws IOException
	 */
	long getCursor() throws IOException;

	/**
	 * Moves the cursor of a provided amount of bytes. <br>
	 * <br>
	 * Note that in case the provided amount is negative, the pointer will be
	 * moved back.
	 * 
	 * @param amount
	 * @return Returns the new cursor position.
	 * @throws IOException
	 */
	long shift(int amount) throws IOException;

	/**
	 * moves the cursor at the beginning of the file (the 0 position).
	 * 
	 * @throws IOException
	 */
	void rewind() throws IOException;

	/**
	 * Reads a string from the file, starting from the cursor within the file.
	 * 
	 * @return
	 * @throws IOException
	 */
	String readString() throws IOException;

	/**
	 * Read a byte array from the resource. The byte array represents a string.
	 * 
	 * @return
	 * @throws IOException
	 */
	byte[] readStringAsBytes() throws IOException;

	/**
	 * Reads a double from the file, starting from the cursor within the file.
	 * 
	 * @return
	 * @throws IOException
	 */
	double readDouble() throws IOException;

	float readFloat() throws IOException;

	long readLong() throws IOException;

	int readInt() throws IOException;

	short readShort() throws IOException;

	char readChar() throws IOException;

	byte readByte() throws IOException;

	boolean readBoolean() throws IOException;

	byte readType() throws IOException;
}
